home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1994 November / macformat-018.iso / Comms Spectacular / YModem Tool GH 1.0 Folder / YModem Tool GH--Read Me next >
Encoding:
Text File  |  1994-09-08  |  9.8 KB  |  2 lines  |  [TEXT/R*ch]

  1. YModem Tool v 1.0 ©Glenn R. Howes 1993 --> shareware version
  2. --------------------------------------
  3.  
  4. **************************************
  5. This is the first release of this tool. Redistribute it as you wish with the
  6. exception that vendors must obtain a license from me to bundle
  7. this tool with commercial software.
  8.  
  9. Please include this read me file with the tool.
  10. **************************************
  11.  
  12. version history:
  13.     initial release 1.0
  14.  
  15. Description:
  16.     This Macintosh Communications Toolbox file transfer tool implements the YModem
  17.     transfer protocol has described by Chuck Forsberg in his paper
  18.     "XMODEM/YMODEM PROTOCOL REFERENCE". YModem is a simple batch sending protocol 
  19.     designed for 8-bit connections. 
  20.  
  21. Useage:
  22.      1) Acquire a CTB capable applications: ClarisWorks, Termy, VersaTerm, etc.
  23.      2) For System 6 users (6.0.4 and up) install the communications toolbox
  24.         (available from Apple).
  25.      3) Place this tool in the Extension folder for System 7 or the Communications
  26.         folder for system 6.
  27.      4) Run your application and select this tool from the appropriate dialog.
  28.      5) Connect up with a remote computer and run a X,Y or Z program on it. 
  29.          (sb and rb on Unix machines). The connection must be transparent to all
  30.          8 bit characters. 
  31.          
  32. Problems:
  33.     If a transfer won't start, or proceeds for a few thousand bytes and then stops,
  34.     the most likely problem is the connection is not 100% 8 bit clean. There is 
  35.     nothing that can be done about this other then trying another connection, or
  36.     using Kermit (or sometimes ZModem). Sometimes, you can receive but not send
  37.     files, depending on the setup.
  38.     
  39.     If YModem-g mode works sporadically, the most likely problem is that the 
  40.     receiver is unable to keep up with the data stream and the connection tools
  41.     buffer is overflowing. You need some sort of flow control to solve this, and
  42.     avoid using this option while doing transfers in the background. Better yet,
  43.     don't use this option.
  44.     
  45.     If auto-receive doesn't work, perhaps your application doesn't support it, or
  46.     maybe the trigger selected doesn't match the output of the remote program
  47.     (in which case see "Lovers of ResEdit" below).
  48.     
  49.     If you want the modified time of downloaded non-macbinary files to be right,
  50.     try using the Map control panel to set your current location. (YModem uses
  51.     Greenwich Mean Time to specify this parameter).
  52.     
  53.     If while using Versaterm 4.6.2 or before, you experience a system freeze 
  54.     always at the beginning of a transfer, upgrade to 4.6.3 or later. (Or use
  55.     Versaterm's built in YModem :) ).
  56.     
  57.     If the tool cancels on a transfer error, but the remote keeps on sending
  58.     data in -g mode, you can try holding down the control key and hitting the
  59.     "x" key a few times, this might work, but then again, it might not, because
  60.     the tool already tried it. In this case, there isn't much to do but wait for
  61.     the file to be finished or disconnect.
  62.     
  63.     If text files show up a one long line. You are probably having the remote
  64.     send Unix text, while the tool is set for PC Text. If it is one long line
  65.     interspersed by "
  66. ", you are probably sending Unix text and receiving in 
  67.     binary. If the text is double spaced, you are probably sending PC Text and
  68.     receiving Unix text. The safest way is probably to send/receive text in ascii
  69.     mode with a tool setting of "PC Text" (for example by using the Unix commands
  70.     "sb -a filename" and "rb -a").
  71.      
  72. Options:
  73.     •     Use YModem-g, a turbo version of YModem which assumes no transmission errors
  74.             will occur. If errors occur the transfer will automatically fail.
  75.             Try using this method if you wish, but be prepared to abandon it.
  76.             This effects only files being received. To send in -g mode, you have
  77.             to tell the receiving program to use streaming mode (for example,
  78.             in Unix typing "rb -g".
  79.     •    Use 1-K blocks, in order to increase the transfer speed send data in 
  80.             1 kilobyte blocks instead of 128 byte blocks. This may be a problem when
  81.             dealing with some XModem implementations. This only effects packets
  82.             sent by this tool. You have to tell the remote computer to send 1K 
  83.             packets (for example by typing "sb -k filename").
  84.     •    Method popup menu:
  85.             macbinary: send files in macbinary format, this is the only way to
  86.                 transmit most mac specific files. In receiving mode, files are 
  87.                 checked for macbinary format and decoded if they are macbinary.
  88.             binary: send a file's "data" fork untouched. Use for binary data files
  89.                 such as compressed archives, or for sending text files to another 
  90.                 macintosh.
  91.             unix text: on sending, replace all instances of the carriage return 
  92.                 character with a line feed, on receiving, replace all instance of the
  93.                 line feed character with a carriage return. Alternatively, you
  94.                 could tell the remote Unix machine to send pc text (usually by using
  95.                 the command "sb -a filename".
  96.             pc text: on sending, add a line feed after every carriage return,
  97.                 on receiving, remove all line feeds. This is the format that YModems 
  98.                 expects generic text files to be in (when you type "rb -a" for
  99.                 instance).
  100.     •     Creator: This 4 character token represents the application that you wish to
  101.             use to open a downloaded document. This will be overridden in valid
  102.             macbinary downloads.
  103.     •    Type: This 4 character token represents the format type you believe the 
  104.             downloaded document to be in. This will be overridden in valid macbinary
  105.             downloads.
  106.     •    Set Document Type…: This button will bring up a standard file dialog asking
  107.             you to select another document of the same type as the document, or an
  108.             application which will be used to open it. This will fill in the 
  109.             Creator and Type items.
  110.     •     Save Preferences: This button will take the current parameters and store them
  111.             into a preference file (located in the preferences folder of system 7 or the
  112.             system folder of system 6). Then when you switch back to this tool from using
  113.             another or when setting up a new session document, these parameters will
  114.             appear by default
  115.     •     Modify Sent Filename: Outgoing file names are converted to a format more 
  116.             friendly for unix systems.
  117.     •     UseAutoreceive: Some CTB compliant applications allow the file transfer tool
  118.             to specify a string of characters in the data stream to look for; when they
  119.             appear, the application invokes the tool in receive mode.
  120.     •    Trigger: This is a menu that describes the string used to trigger autoreceiving.
  121.             I've put in "Macbinary" (which will invoke when <ESC>b is sent, "sz" which
  122.             will invoke when <CAN>B0000 is sent, "and "Start Your..." which will
  123.             activate when "Start your YModem Receive". Of course, if you were reading
  124.             this message on your terminal when the above line was shown, you might
  125.             have gone into receive mode. So be wary.
  126.             
  127.             You can add your own (see "Lovers of Resedit" below.). The Macbinary 
  128.             option will also send out a <ESC>b when starting to send.
  129.             
  130. Notes to Developers:
  131.     • I expect a hard dialog ID in the FSSpec passed to the tool on the ftReceiveMsg.
  132.         If you pass me a notification pointer, I will call it after closing each
  133.         successfully transferred file.
  134.     • If you pass me an array of FSSpecs for a ftSendMsg, I copy it
  135.         right away, so you can dispose of the original if you want.
  136.     • I set the autoreceive string in both the fval and fcsr code (so look) for it,
  137.         if you implement that feature.
  138.     
  139.     
  140. Lovers of ResEdit:
  141.     You can add your own autoreceive strings by:
  142.         1) Open the 'Auto' resources and create a new one with the next number
  143.             sequentially from those already there. These are stored as hex 
  144.             representations of pascal strings so remember to put in a length 
  145.             byte first.
  146.         2) adding an item to the 'MENU' resource used in the setup box 
  147.         3) If you really like to go the whole nine yards, you can add a balloon help
  148.             string by looking in the 'STR#' resources and adding another one to the
  149.             "trigger strings" resource.
  150.     You can change the keywords used in macros by opening the 'STR#' labled
  151.         macro types and macro values. These keywords must be lowercase and end with
  152.         a space.
  153.     If you don't like the wording of anything in the status window, most of the
  154.         strings used are stored in a 'STR#' resource labled "status strings".
  155.         
  156. ************
  157. Don't distribute modified copies.
  158. ************
  159.             
  160. Legalisms:
  161.  I, Glenn R. Howes, retain all rights to this tool and to its source code.
  162.  It shall not be bundled with commercial applications capable of 
  163.  making use of it, nor sent by a vendor of such an application to a customer
  164.  without a license from me. A licensable version is available
  165.  for commercial vendors.
  166.  
  167.  This tool is the shareware version. If you use it for two weeks feel obliged 
  168.  to send me $8 US to the address below.
  169.  
  170.  I give no warranty for this tool. Any loss or damage brought about by its useage 
  171.  is not my responsibility. The user takes his chances when using any piece of 
  172.  software, including this one.
  173.  
  174. Complaints/Ideas/Offers/Salutations: (even if you didn't pay a fee)
  175.  Glenn R. Howes
  176.  1101 University Ave.
  177.  Madison, WI 53706
  178.  
  179.  Internet: howes@bert.chem.wisc.edu
  180.  
  181. Thanks to:
  182.  • Ed Turner for loaning me "Inside the Macintosh Communication's Toolbox"
  183.  • Chuck Forsberg for inventing YModem and writing "XMODEM/YMODEM PROTOCOL REFERENCE".
  184.  • Stephen Satchell for writing and putting into the public domain the lookup 
  185.      cyclic redundancy algorithm used in my packet error checking and macbinary II
  186.      generation routines.
  187.  • Jim Matthews for providing the code for extracting the Finder comments found in 
  188.    Macbinary files. Sorry, I haven't incorporated the code to put comments into my
  189.    own Macbinary generation.
  190.  • Brian Hall for his constant stream of suggestions.
  191.  • My beta testers: esp. Bill Lippa, John Rawnsley and Alex Rosenberg.
  192.  • The teachers of the St. Thomas Aquinas elementary school in International Falls, MN;
  193.      nothing like a solid Catholic education to drum the fundamentals into you.
  194.  • Dave Mark and Cartright Reed for writing the "Macintosh C Programming Primer",
  195.    which started me on this journey in the first place.